Skip to content

Conversation

@michael-apify
Copy link
Contributor

@michael-apify michael-apify commented Nov 13, 2025

Note

Clarifies OpenAPI docs for maxItems (pay-per-result charge cap) and maxTotalChargeUsd (pay-per-event cost cap) across actor and task run endpoints, including env var references.

  • OpenAPI (Actors & Actor tasks)
    • Update maxItems query param description in actors/*run-sync*.yaml and actor-tasks/*run-sync*.yaml:
      • Clarifies it caps chargeable dataset items for pay-per-result actors, not returned items; references ACTOR_MAX_PAID_DATASET_ITEMS.
    • Update maxTotalChargeUsd query param description in actors/*runs*.yaml, actors/*run-sync*.yaml, and actor-tasks/*runs*.yaml:
      • Specifies it's used only for pay-per-event actors and references ACTOR_MAX_TOTAL_CHARGE_USD.

Written by Cursor Bugbot for commit 99fc4f1. Configure here.

@michael-apify michael-apify added the adhoc Ad-hoc unplanned task added during the sprint. label Nov 13, 2025
@michael-apify michael-apify added the t-c&c Team covering store and finance matters. label Nov 13, 2025
@apify-service-account
Copy link

Preview for this PR was built for commit 99fc4f1 and is ready at https://pr-2088.preview.docs.apify.com!

@janbuchar
Copy link
Contributor

While you're at it, could you please also add maxItems and maxTotalChargeUsd to the response schema in RunOptions.yaml?

Copy link
Contributor

@stetizu1 stetizu1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably can't do anything about it now, but yes, it goes against our "unify pricing" initiative when we "name" the pricing models and then somehow hide it in the UI 😅

@apify-service-account
Copy link

Preview for this PR was built for commit b95fc58d and is ready at https://pr-2088.preview.docs.apify.com!

@apify-service-account
Copy link

Preview for this PR was built for commit 12542cf1 and is ready at https://pr-2088.preview.docs.apify.com!

Comment on lines +7 to +8
- maxItems
- maxTotalChargeUsd
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these actually required?

results that will be charged to your subscription. You can access the
maximum number of items in your Actor by using the
`ACTOR_MAX_PAID_DATASET_ITEMS` environment variable.
Specifies the maximum number of dataset items that will be charged for pay-per-result Actors.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see quite a bit of repetition here - could you make some reusable parameter objects and reference them in the relevant endpoints? See https://swagger.io/specification/#components-object

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. t-c&c Team covering store and finance matters.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants